Add docs for Cancelling invocation #51
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Please provide an explanation of the changes you've made:
This PR adds documentation for stopping/cancelling invocations via the API. Previously, the docs stated that stopping invocations via API was "coming very soon". This update provides clear examples showing how to stop an invocation by setting its status to
failed, with code examples in both TypeScript/JavaScript and Python.Implementation Checklist
Testing
mintlify devworks (see installation here)Docs
This PR is already in the docs repo
Visual Proof
Please provide a screenshot or video demonstrating that your changes work locally:
The updated documentation shows:
failedRelated Issue
Fixes [Github issue link]
[If this corresponds to a fix from another Kernel OSS repo, include this:]
No specific issue linked - this was a documentation improvement based on the Go client example provided
Additional Notes
@onkernel/sdk(npm) andkernel(pip) packages and testing the method signatures<CodeGroup>for multi-language examplesTL;DR
Added documentation for cancelling an API invocation by setting its status to
failed.Why we made these changes
The previous documentation for this feature was a "coming soon" placeholder. This PR adds the official guide and code examples so users can cancel in-progress invocations via the API.
What changed?
apps/invoke.mdxto replace the placeholder with a guide on cancelling invocations.<CodeGroup>for both TypeScript/JavaScript and Python, demonstrating how to patch the invocation's status.Description generated by Mesa. Update settings